<?php

namespace PHPExcel\Style;

/**
 * PHPExcel_Style_Protection
 *
 * Copyright (c) 2006 - 2015 PHPExcel
 *
 * This library is free software; you can redistribute it and/or
 * modify it under the terms of the GNU Lesser General Public
 * License as published by the Free Software Foundation; either
 * version 2.1 of the License, or (at your option) any later version.
 *
 * This library is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
 * Lesser General Public License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public
 * License along with this library; if not, write to the Free Software
 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
 *
 * @category PHPExcel
 * @package PHPExcel_Style
 * @copyright Copyright (c) 2006 - 2015 PHPExcel (http://www.codeplex.com/PHPExcel)
 * @license http://www.gnu.org/licenses/old-licenses/lgpl-2.1.txt LGPL
 * @version ##VERSION##, ##DATE##
 */
class Protection extends Supervisor implements \PHPExcel\IComparable {
    /**
     * Protection styles
     */
    const PROTECTION_INHERIT = 'inherit';
    const PROTECTION_PROTECTED = 'protected';
    const PROTECTION_UNPROTECTED = 'unprotected';
    
    /**
     * Locked
     *
     * @var string
     */
    protected $locked;
    
    /**
     * Hidden
     *
     * @var string
     */
    protected $hidden;
    
    /**
     * Create a new Protection
     *
     * @param boolean $isSupervisor
     *            Flag indicating if this is a supervisor or not
     *            Leave this value at default unless you understand exactly what
     *            its ramifications are
     * @param boolean $isConditional
     *            Flag indicating if this is a conditional style or not
     *            Leave this value at default unless you understand exactly what
     *            its ramifications are
     */
    public function __construct($isSupervisor = false, $isConditional = false) {
        // Supervisor?
        parent::__construct($isSupervisor);
        
        // Initialise values
        if (!$isConditional) {
            $this->locked = self::PROTECTION_INHERIT;
            $this->hidden = self::PROTECTION_INHERIT;
        }
    }
    
    /**
     * Get the shared style component for the currently active cell in currently active sheet.
     * Only used for style supervisor
     *
     * @return Protection
     */
    public function getSharedComponent() {
        return $this->parent->getSharedComponent()->getProtection();
    }
    
    /**
     * Build style array from subcomponents
     *
     * @param array $array            
     * @return array
     */
    public function getStyleArray($array) {
        return array(
        'protection' => $array 
        );
    }
    
    /**
     * Apply styles from array
     *
     * <code>
     * $objPHPExcel->getActiveSheet()->getStyle('B2')->getLocked()->applyFromArray(
     * array(
     * 'locked' => TRUE,
     * 'hidden' => FALSE
     * )
     * );
     * </code>
     *
     * @param array $pStyles
     *            Array containing style information
     * @throws \PHPExcel\Exception
     * @return Protection
     */
    public function applyFromArray($pStyles = null) {
        if (is_array($pStyles)) {
            if ($this->isSupervisor) {
                $this->getActiveSheet()->getStyle($this->getSelectedCells())->applyFromArray($this->getStyleArray($pStyles));
            } else {
                if (isset($pStyles['locked'])) {
                    $this->setLocked($pStyles['locked']);
                }
                if (isset($pStyles['hidden'])) {
                    $this->setHidden($pStyles['hidden']);
                }
            }
        } else {
            throw new \PHPExcel\Exception("Invalid style array passed.");
        }
        return $this;
    }
    
    /**
     * Get locked
     *
     * @return string
     */
    public function getLocked() {
        if ($this->isSupervisor) {
            return $this->getSharedComponent()->getLocked();
        }
        return $this->locked;
    }
    
    /**
     * Set locked
     *
     * @param string $pValue            
     * @return Protection
     */
    public function setLocked($pValue = self::PROTECTION_INHERIT) {
        if ($this->isSupervisor) {
            $styleArray = $this->getStyleArray(array(
            'locked' => $pValue 
            ));
            $this->getActiveSheet()->getStyle($this->getSelectedCells())->applyFromArray($styleArray);
        } else {
            $this->locked = $pValue;
        }
        return $this;
    }
    
    /**
     * Get hidden
     *
     * @return string
     */
    public function getHidden() {
        if ($this->isSupervisor) {
            return $this->getSharedComponent()->getHidden();
        }
        return $this->hidden;
    }
    
    /**
     * Set hidden
     *
     * @param string $pValue            
     * @return Protection
     */
    public function setHidden($pValue = self::PROTECTION_INHERIT) {
        if ($this->isSupervisor) {
            $styleArray = $this->getStyleArray(array(
            'hidden' => $pValue 
            ));
            $this->getActiveSheet()->getStyle($this->getSelectedCells())->applyFromArray($styleArray);
        } else {
            $this->hidden = $pValue;
        }
        return $this;
    }
    
    /**
     * Get hash code
     *
     * @return string Hash code
     */
    public function getHashCode() {
        if ($this->isSupervisor) {
            return $this->getSharedComponent()->getHashCode();
        }
        return md5($this->locked . $this->hidden . __CLASS__);
    }
}
